feat: Add PlatformOrGuideName and PlatformSdkPackageName components
#9200
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
Lms24
commented
Feb 22, 2024
Comment on lines
+29
to
+37
| - Install the <PlatformSdkPackageName fallback="@sentry/browser"/> SDK, minimum version 7.60.0 | ||
| - Configure the document response header to include `Document-Policy: js-profiling` | ||
| - Configure the SDK to use the `BrowserProfilingIntegration` and set `profilesSampleRate` | ||
|
|
||
| ## Step 1: Install the JavaScript Browser SDK | ||
| ## Step 1: Install the <PlatformOrGuideName/> SDK | ||
|
|
||
| <PlatformSection notSupported={["javascript.electron"]}> | ||
|
|
||
| Install our JavaScript browser SDK using either `yarn` or `npm`, the minimum version that supports profiling is **7.60.0**. | ||
| Install our <PlatformOrGuideName/> SDK using either `yarn` or `npm`, the minimum version that supports profiling is **7.60.0**. |
There was a problem hiding this comment.
This is the concrete use case I want to fix (which was reported by our sales engineers today in Slack).
mjq-sentry
suggested changes
Feb 27, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds two components that return the name and SDK package name of the currently selected platform.
PlatformSdkPackageNamereturns the package name, e.g.@sentry/nextjsPlatformOrGuideNamereturns the name of the currently selected platform or guide, e.g.Next.JSMotivation: We have a lot of pages where we statically write a package name (e.g.
@sentry/browser) which doesn't change when users select a guide (e.g. NextJS). This leads to confusion. Reportedly from SEs, thought they'd need to install and initialize the browser SDK in addition to the NextJS SDK.Alternatives: Sure, we could also copy the guide per platform (IIRC we did this for Replay a while back) but it's arguably more work if the changes between these files are literally the name of a package or framework.
Let me know what you think, happy to adjust or close this if you have better ideas!
Example page with dynamic sdk/platform name
PS: Please assume I know next to nothing about NextJS or RSC when reviewing this PR ;)